
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>start-local-instance</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>start-local-instance</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="start-instance.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="stop-cluster.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="start-local-instance-1"></a><a id="GSRFM00237"></a><a id="start-local-instance"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_start_local_instance">start-local-instance</h2>
<div class="sectionbody">
<div class="paragraph">
<p>starts a \{product---name} instance on the host where the subcommand is
run</p>
</div>
<div id="sthref2142" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] start-local-instance [--help]
[--nodedir node-dir] [--node node]
[--debug={false|true}] [--dry-run={true|false}]
[--sync={normal|full|none}]
[--verbose={false|true}] [--watchdog={true|false}]
[instance-name]</code></pre>
</div>
</div>
<div id="sthref2143" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>start-local-instance</code> subcommand starts a \{product---name}
instance on the host where the subcommand is run. This subcommand does
not require the Distributed Component Object Model (DCOM) remote
protocol or secure shell (SSH) to be configured. You must run this
command from the host where the instance resides.</p>
</div>
<div class="paragraph">
<p>The subcommand can start any \{product---name} instance, regardless of
how the instance was created. For example, this subcommand can start an
instance that was created by using the
<a href="create-instance.html#create-instance-1"><code>create-instance</code>(1)</a>
subcommand.</p>
</div>
<div class="paragraph">
<p>The <code>start-local-instance</code> subcommand does not contact the domain
administration server (DAS) to determine the node on which the instance
resides. To determine the node on which the instance resides, the
subcommand searches the directory that contains the node directories. If
multiple node directories exist, the node must be specified as an option
of the subcommand.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in local mode. However, to synchronize the
instance with the DAS, this subcommand must be run in remote mode.</p>
</div>
<div id="sthref2144" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--nodedir</code></dt>
<dd>
<p>Specifies the directory that contains the instance&#8217;s node directory.
The instance&#8217;s files are stored in the instance&#8217;s node directory. The
default is as-install`/nodes`.</p>
</dd>
<dt class="hdlist1"><code>--node</code></dt>
<dd>
<p>Specifies the node on which the instance resides. This option may be
omitted only if the directory that the <code>--nodedir</code> option specifies
contains only one node directory. Otherwise, this option is required.</p>
</dd>
<dt class="hdlist1"><code>--debug</code></dt>
<dt class="hdlist1"><code>-d</code></dt>
<dd>
<p>Specifies whether the instance is started with
Java Platform Debugger Architecture (JPDA)
debugging enabled.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The instance is started with JPDA debugging enabled and the port
number for JPDA debugging is displayed.</p>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The instance is started with JPDA debugging disabled (default).</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--dry-run</code></dt>
<dt class="hdlist1"><code>-n</code></dt>
<dd>
<p>Suppresses actual starting of the instance. Instead,
<code>start-local-instance</code> displays the full command that would be used to
start the instance, including all options. Reviewing this command can
be useful when troubleshooting startup issues.<br>
The default value is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--sync</code></dt>
<dd>
<p>The type of synchronization between the DAS and the instance&#8217;s files
when the instance is started.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>none</code></dt>
<dd>
<p>The DAS does not synchronize the instance&#8217;s files with any changes.
This type of synchronization minimizes the time that is required to
start the instance.</p>
</dd>
<dt class="hdlist1"><code>normal</code></dt>
<dd>
<p>The DAS synchronizes the instance with changes since the last
synchronization as follows:<br></p>
<div class="ulist">
<ul>
<li>
<p>For the <code>config</code> directory, the DAS synchronizes the instance with
all changes.</p>
</li>
<li>
<p>For the <code>applications</code> directory and <code>docroot</code> directory, only a
change to a top-level subdirectory causes the DAS to synchronize all
files under that subdirectory.<br>
If a file below a top level subdirectory is changed without a change
to a file in the top level subdirectory, full synchronization is
required. In normal operation, files below the top level
subdirectories of these directories are not changed. If an
application is deployed and undeployed, full synchronization is not
necessary to update the instance with the change.<br>
This value is the default.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1"><code>full</code></dt>
<dd>
<p>The DAS synchronizes the instance with all of the instance&#8217;s files,
regardless of whether the files have changed since the last
synchronization. This type of synchronization might delay the
startup of the instance while the DAS updates all files in the
instance&#8217;s directories.<br></p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 100%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>Caution:</p>
</div>
<div class="paragraph">
<p>If the DAS is not running or is unreachable from the host where you
are running this subcommand, do not set the <code>--sync</code> option to
<code>full</code>. To perform a full synchronization, the subcommand removes
the instance&#8217;s cache. If the DAS cannot be contacted to replace the
cache, the subcommand fails and the instance cannot be restarted
until it is resynchronized with the DAS.</p>
</div></div></td>
</tr>
</tbody>
</table>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>--verbose</code></dt>
<dt class="hdlist1"><code>-v</code></dt>
<dd>
<p>Specifies whether detailed information about the instance is displayed
in the console window where the subcommand is run.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>Detailed startup messages and log messages about the instance are
displayed in the console window where the subcommand is run. If the
instance is later restarted by running the
<a href="restart-local-instance.html#restart-local-instance-1"><code>restart-local-instance</code>(1)</a>
subcommand from a different console window, messages continue to be
displayed in the original console window.<br>
You can kill the \{product---name} process by typing <code>CTRL-C</code> in the
console window.<br>
You can kill the \{product---name} process and obtain a thread dump
for the server by typing one of the following key combinations in
the console window:<br></p>
<div class="ulist">
<ul>
<li>
<p><code>CTRL-\</code> on UNIX systems</p>
</li>
<li>
<p><code>CTRL-Break</code> on Windows systems</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>Detailed information is not displayed (default).</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--watchdog</code></dt>
<dt class="hdlist1"><code>-w</code></dt>
<dd>
<p>Specifies whether limited information about the instance is displayed
in the console window where the subcommand is run. The <code>--watchdog</code>
option is similar to <code>--verbose</code> but does not display the detailed
startup messages and log messages. This option is useful when running
the <code>asadmin</code> utility in the background or with no attached console.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>Limited information is displayed in the console window.</p>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>Limited information is not displayed in the console window
(default).</p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref2145" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">instance-name</dt>
<dd>
<p>The name of the instance to start.</p>
</dd>
</dl>
</div>
<div id="sthref2146" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM763"></a><a id="sthref2147"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Starting an Instance Locally</p>
</div>
<div class="paragraph">
<p>This example starts the instance <code>yml-i-sj01</code> on the host where the
subcommand is run.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; start-local-instance --node sj01 yml-i-sj01
Waiting for the server to start .................................
Successfully started the instance: yml-i-sj01
instance Location: /export/glassfish3/glassfish/nodes/sj01/yml-i-sj01
Log File: /export/glassfish3/glassfish/nodes/sj01/yml-i-sj01/logs/server.log
Admin Port: 24849
Command start-local-instance executed successfully.</code></pre>
</div>
</div>
<div id="sthref2148" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2149" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="create-instance.html#create-instance-1"><code>create-instance</code>(1)</a>,
<a href="create-local-instance.html#create-local-instance-1"><code>create-local-instance</code>(1)</a>,
<a href="delete-instance.html#delete-instance-1"><code>delete-instance</code>(1)</a>,
<a href="delete-local-instance.html#delete-local-instance-1"><code>delete-local-instance</code>(1)</a>,
<a href="restart-instance.html#restart-instance-1"><code>restart-instance</code>(1)</a>,
<a href="restart-local-instance.html#restart-local-instance-1"><code>restart-local-instance</code>(1)</a>,
<a href="start-domain.html#start-domain-1"><code>start-domain</code>(1)</a>,
<a href="start-instance.html#start-instance-1"><code>start-instance</code>(1)</a>,
<a href="stop-domain.html#stop-domain-1"><code>stop-domain</code>(1)</a>,
<a href="stop-instance.html#stop-instance-1"><code>stop-instance</code>(1)</a>,
<a href="stop-local-instance.html#stop-local-instance-1"><code>stop-local-instance</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="start-instance.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="stop-cluster.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
